<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>bitget-node-sdk-api</title>
	<meta name="description" content="Documentation for bitget-node-sdk-api">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="index.html" class="title">bitget-node-sdk-api</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="globals.html">Globals</a>
				</li>
			</ul>
			<h1>bitget-node-sdk-api</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<div class="tsd-panel tsd-typography">
				<a href="#bitget-node-sdk-api" id="bitget-node-sdk-api" style="color: inherit; text-decoration: none;">
					<h1>bitget-node-sdk-api</h1>
				</a>
				<a href="#使用说明" id="使用说明" style="color: inherit; text-decoration: none;">
					<h2>使用说明</h2>
				</a>
				<p>本SDK开发环境为v10.15.3，TypeScript(tsc)版本为3.9.7<br>依赖axios作为网络请求库，需要时可参阅 <a href="https://github.com/axios/axios">官方文档</a>  </p>
				<pre><code class="language-bash">git <span class="hljs-built_in">clone</span> https://github.com/BitgetLimited/v3-bitget-api-sdk.git
<span class="hljs-built_in">cd</span> v3-bitget-api-sdk/bitget-node-sdk-api
npm install
npm build</code></pre>
				<ul>
					<li><strong>test</strong>目录存放相关测试用例，SDK调用方式可以参考  </li>
					<li>build目录存放CommonJS规范模块输出，需要其他规范可自行修改tsconfig.json进行编译  </li>
					<li>doc目录存放使用typedoc工具自动生成的类型声明文档(HTML版)</li>
				</ul>
				<p>本SDK基于 <a href="https://bitgetlimited.github.io/apidoc/zh/swap/#25e54147de">api文档</a> 实现</p>
			</div>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="globals.html"><em>Globals</em></a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_index_.html">&quot;src/index&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_authenticatedapi_.html">&quot;src/lib/authenticated<wbr>Api&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_config_.html">&quot;src/lib/config&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_mix_mixaccountapi_.html">&quot;src/lib/mix/<wbr>Mix<wbr>Account<wbr>Api&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_model_mix_opencountreq_.html">&quot;src/lib/model/mix/<wbr>Open<wbr>Count<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_model_mix_setleveragereq_.html">&quot;src/lib/model/mix/<wbr>Set<wbr>Leverage<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_model_mix_setmarginmodereq_.html">&quot;src/lib/model/mix/<wbr>Set<wbr>Margin<wbr>Mode<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_model_mix_setmarginreq_.html">&quot;src/lib/model/mix/<wbr>Set<wbr>Margin<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_model_mix_setpositionmodereq_.html">&quot;src/lib/model/mix/<wbr>Set<wbr>Position<wbr>Mode<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_publicapi_.html">&quot;src/lib/public<wbr>Api&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_util_.html">&quot;src/lib/util&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="modules/_src_lib_ws_bitgetwsclient_.html">&quot;src/lib/ws/<wbr>Bitget<wbr>WsClient&quot;</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>